ValidatedIdentifier

open class ValidatedIdentifier @JvmOverloads constructor(defaultValue: Identifier, val allowableIds: AllowableIdentifiers, validator: EntryValidator<Identifier> = allowableIds) : ValidatedField<Identifier> , Updatable, Translatable, Comparable<Identifier>

A validated Identifier field.

There are various shortcut methods available for building ValidatedIdentifiers more easily than with the primary constructor. Check out options in the See Also section

Author

fzzyhmstrs

Since

0.1.2

Parameters

defaultValue

String, the string value of the default identifier

allowableIds

AllowableIdentifiers instance. Defines the predicate for valid ids, and the supplier of valid id lists

validator

EntryValidator handles validation of individual entries. Defaults to validation based on the predicate provided in allowableIds

See also

Samples

import me.fzzyhmstrs.fzzy_config.util.AllowableIdentifiers
import me.fzzyhmstrs.fzzy_config.util.EnumTranslatable
import me.fzzyhmstrs.fzzy_config.util.ValidationResult
import me.fzzyhmstrs.fzzy_config.validation.collection.ValidatedList
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedIdentifier
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedRegistryType
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedTagKey
import me.fzzyhmstrs.fzzy_config.validation.misc.*
import me.fzzyhmstrs.fzzy_config.validation.misc.ValidatedColor.Companion.validatedColor
import me.fzzyhmstrs.fzzy_config.validation.number.ValidatedInt
import net.minecraft.item.Items
import net.minecraft.item.SwordItem
import net.minecraft.registry.Registries
import net.minecraft.registry.tag.ItemTags
import net.minecraft.util.Identifier
import java.awt.Color
import java.util.function.Function

fun main() { 
   //sampleStart 
   //Example validated identifier. Note that this "raw" usage of the constructor is not recommended in most cases.
//For instance, in this case, an implementation of ofRegistry(Registry, BiPredicate) would be advisable
val validatedIdentifier = ValidatedIdentifier(Identifier.of("oak_planks"), AllowableIdentifiers({ id -> id.toString().contains("planks") }, { Registries.BLOCK.ids.filter { it.toString().contains("planks") } }))

//Unbounded validated Identifier. Any valid Identifier will be allowed
val unboundedIdentifier = ValidatedIdentifier(Identifier.of("nether_star"))

//Unbounded validated Identifier directly from string. Any valid Identifier will be allowed
val stringIdentifier = ValidatedIdentifier("nether_star")

//Unbounded validated Identifier directly from string nbamespace and path. Any valid Identifier will be allowed
val stringStringIdentifier = ValidatedIdentifier("minecraft", "nether_star")

//Unbounded validated Identifier with a dummy default. used only for validation of other things
val emptyIdentifier = ValidatedIdentifier()

//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
    "_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
    "my_mod.my_config.subSection.fieldName": "Very Important Setting",
    "my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
""" 
   //sampleEnd
}

Constructors

Link copied to clipboard
constructor(defaultValue: Identifier)

An unbounded validated identifier

constructor(defaultValue: String)

An unbounded validated identifier constructed from a string

constructor(defaultNamespace: String, defaultPath: String)

An unbounded validated identifier constructed from namespace and path strings

constructor()

An unbounded validated identifier with a dummy default value

constructor(defaultValue: Identifier, allowableIds: AllowableIdentifiers, validator: EntryValidator<Identifier> = allowableIds)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open override fun accept(input: Identifier)

updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet

Link copied to clipboard
open fun addListener(listener: Consumer<ValidatedField<Identifier>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

Link copied to clipboard
open fun andThen(p0: Consumer<in Identifier>): Consumer<Identifier>
Link copied to clipboard
Link copied to clipboard
fun codec(): Codec<Identifier>

Provides a Codec representing the value type of this validation, backed by the validators within, as applicable

Link copied to clipboard
open operator override fun compareTo(other: Identifier): Int
Link copied to clipboard
open override fun copyStoredValue(): Identifier

Creates a deep copy of the stored value and returns it

Link copied to clipboard
open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

Link copied to clipboard
open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun get(): Identifier

supplies the wrapped value

Link copied to clipboard
fun getDefault(): Identifier

Provides this validations default value

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Whether this Translatable has a valid description

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard

Whether this Translatable has a valid translation

Link copied to clipboard
open override fun instanceEntry(): ValidatedIdentifier

creates a deep copy of this ValidatedIdentifier

Link copied to clipboard
fun <N> map(to: Function<Identifier, out N>, from: Function<in N, Identifier>): ValidatedField<N>

Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue

fun <N> map(defaultValue: N, to: Function<Identifier, out N>, from: Function<in N, Identifier>): ValidatedField<N>
fun <N> map(to: Function<Identifier, out N>, from: Function<in N, Identifier>, defaultValue: Identifier): ValidatedField<N>

Maps this validation to a new convertible type.

Link copied to clipboard
fun toList(vararg elements: Identifier): ValidatedList<Identifier>

wraps the provided values into a ValidatedList with this field as validation

fun toList(collection: Collection<Identifier>): ValidatedList<Identifier>

wraps the provided collection into a ValidatedList with this field as validation

Link copied to clipboard
fun toSet(vararg elements: Identifier): ValidatedSet<Identifier>

wraps the provided values into a ValidatedSet with this field as validation

fun toSet(collection: Collection<Identifier>): ValidatedList<Identifier>

wraps the provided collection into a ValidatedList with this field as validation

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun translation(fallback: String?): MutableText

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)

Link copied to clipboard
open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

Link copied to clipboard
fun trySerialize(input: Any?, errorBuilder: MutableList<String>, flags: Byte): TomlElement?
Link copied to clipboard
open override fun trySet(input: Any?)
Link copied to clipboard
open fun update(updateMessage: Text)
Link copied to clipboard
open fun validateAndSet(input: Identifier): ValidationResult<Identifier>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

Link copied to clipboard
open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<Identifier> = ChoiceValidator.any()): ClickableWidget
Link copied to clipboard
fun withPath(pathFunction: UnaryOperator<String?>): Identifier
fun withPath(path: String?): Identifier
Link copied to clipboard
fun withPrefixedPath(prefix: String): Identifier
Link copied to clipboard
fun withSuffixedPath(suffix: String): Identifier